Version: 1.0.2

List Transaction by Account

The 'List Transaction by Account' API enables to retrieve the list of transactions associated with an account number, and the transactions with their respective details are displayed in required pagination.

Method: POST

{{URL}}/TransactionService/ListTransactions

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API method that is being called to get list of transactions through ledger service Constant value – "TransactionService.ListTransactions"
id Mandatory	String Unique ID of API request Sample value – "1"
params Mandatory	Object
api Mandatory	Object
signature Mandatory	String Signature for request validation Sample value – "signature"
keyId Mandatory	String API key used for request authentication Sample value – "ApplicationKeyId"
credential Mandatory	String API credential provided by NetXD Sample value – "Credential"
payload Mandatory	Object
page Optional	String Page number of transaction list Sample value – 1
size Optional	String Number of transactions per page Sample value – 10
accountNumber Mandatory	String Account number of the customer Sample value – "200742046265302"

Parameter

Description

method

Mandatory

String

API method that is being called to get list of transactions through ledger service

Constant value – "TransactionService.ListTransactions"

Mandatory

String

Unique ID of API request

Sample value – "1"

params

Mandatory

Object

api

Mandatory

Object

signature

Mandatory

String

Signature for request validation

Sample value – "signature"

keyId

Mandatory

String

API key used for request authentication

Sample value – "ApplicationKeyId"

credential

Mandatory

String

API credential provided by NetXD

Sample value – "Credential"

payload

Mandatory

Object

page

Optional

String

Page number of transaction list

Sample value – 1

size

Optional

String

Number of transactions per page

Sample value – 10

accountNumber

Mandatory

String

Account number of the customer

Sample value – "200742046265302"

cURL
C#
Go
NodeJS

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"method":"TransactionService.ListTransactions","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"page":1,"size":10,"accountNumber":"200742046265302"}}}'

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""method"": ""TransactionService.ListTransactions"",
" + "\n" +
@"  ""id"": ""1"",
" + "\n" +
@"  ""params"": {
" + "\n" +
@"    ""api"": {
" + "\n" +
@"      ""signature"": ""{{signature}}"",
" + "\n" +
@"      ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"      ""credential"": ""{{Credential}}""
" + "\n" +
@"    },
" + "\n" +
@"    ""payload"": {
" + "\n" +
@"      ""page"": 1,
" + "\n" +
@"      ""size"": 10,
" + "\n" +
@"      ""accountNumber"": ""200742046265302""
" + "\n" +
@"    }
" + "\n" +
@"  }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
  "method": "TransactionService.ListTransactions",`+"
"+`
  "id": "1",`+"
"+`
  "params": {`+"
"+`
    "api": {`+"
"+`
      "signature": "{{signature}}",`+"
"+`
      "keyId": "{{ApplicationKeyId}}",`+"
"+`
      "credential": "{{Credential}}"`+"
"+`
    },`+"
"+`
    "payload": {`+"
"+`
      "page": 1,`+"
"+`
      "size": 10,`+"
"+`
      "accountNumber": "200742046265302"`+"
"+`
    }`+"
"+`
  }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/jsonrpc',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "TransactionService.ListTransactions",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "page": 1,
      "size": 10,
      "accountNumber": "200742046265302"
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "TransactionService.ListTransactions",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "page": 1,
      "size": 10,
      "accountNumber": "200742046265302"
    }
  }
}

Response: 200

Response Parameters

Parameter	Description
id	String Unique ID of API request Sample value – "1"
result	Object
totalDocs	Number Total number of transactions occurred for the given account Sample value – 2
accountTransactions	Array
type	Enum Type of transaction Valid values: REMITTANCE CARDPAY INTERNAL_TRANSFER WITHDRAW DEPOSIT INTERNAL EFT BILLPAY R2P VOID OPENING_BALANCE FEE_REFUND ISSUE_CARD TAX_REFUND BILLPAY_SADAD ACH_OUT ACH_PULL WIRE_OUT DISBURSEMENT KYC_TRANSACTION GL_TRANSFER WIRE_DD ACH_RETURN RTP_OUT RTP_REVERSAL RTP_IN ICS_DEPOSIT RTP_RFR_OUT RTP_RFR_IN FEDNOW_RFP_OUT FEDNOW_RFR_OUT Sample value – "FEE"
ReferenceID	String Unique reference ID of the transaction Sample value – "XXXSB00000000000236"
timeStamp	String Date and time of transaction is initiated Sample value – "2021-02-16T07:44:55-05:00"
instructedAmount	Object
amount	Number Amount of the transaction Sample value – 100
currency	String Type of currency used for transaction Sample value – "USD"
availableBalance	Object
amount	String Balance amount available in the account Sample value – 9900
currency	String Type of currency Sample value – "USD"
debtorAccount	Object
accountNumber	String Account number of the debtor Sample value – "200654772393698"
customerName	String Full name of the debtor/customer Sample value – "Sam DIAZ"
customerID	String Unique ID of the debtor customer Sample value – "100000000000137"
reference	String Unique reference ID of the transaction Sample value – "txn000013"
creditorAccount	Object
accountNumber	String Account number of the creditor Sample value – "200654772393698"
customerName	String Full name of the creditor/customer Sample value – "Sam DIAZ"
customerID	String Unique ID of the creditor customer Sample value – "100000000000137"
orginalReferenceID	String Unique reference ID of the original transaction for which the fee transaction is done Sample value – "XXXMW20210512000018"
orginalTransactionType	Enum Type of original transaction for which the fee transaction is done Valid values: REMITTANCE CARDPAY INTERNAL_TRANSFER WITHDRAW DEPOSIT INTERNAL EFT BILLPAY R2P VOID OPENING_BALANCE FEE_REFUND ISSUE_CARD TAX_REFUND BILLPAY_SADAD ACH_OUT ACH_PULL WIRE_OUT DISBURSEMENT KYC_TRANSACTION GL_TRANSFER WIRE_DD ACH_RETURN RTP_OUT RTP_REVERSAL RTP_IN ICS_DEPOSIT RTP_RFR_OUT RTP_RFR_IN FEDNOW_RFP_OUT FEDNOW_RFR_OUT Sample value – "PG_DEPOSIT"
processID	String Unique process ID assigned to track end to end process of transaction Sample value – "PL21052500000172"
status	Enum Status of the transaction Valid values: COMPLETED PENDING FAILED DECLINED REJECTED Sample value – "COMPLETED"
mode	Enum Mode of transfer Valid values: PG ACH QRCODE EFT TELLER BENEFIT CHEQUE Sample value – "PG"
customerID	String Unique ID of the creditor customer Sample value – "100000000000137"
transactionID	String Unique transaction identification number Sample value – "2589"
credit	Boolean Indicates whether the transaction type is a credit transaction Sample value – true

{
  "id": "1",
  "result": {
    "totalDocs": 2,
    "accountTransactions": [
      {
        "type": "FEE",
        "ReferenceID": "XXXSB00000000000236",
        "timeStamp": "2021-02-16T07:44:55-05:00",
        "instructedAmount": {
          "amount": 100,
          "currency": "USD"
        },
        "availableBalance": {
          "amount": 9900,
          "currency": "USD"
        },
        "debtorAccount": {
          "accountNumber": "200654772393698",
          "customerName": "Sam DIAZ",
          "customerID": "100000000000137"
        },
        "orginalReferenceID": "XXXMW20210512000018",
        "orginalTransactionType": "PG_DEPOSIT",
        "processID": "PL21052500000172",
        "status": "COMPLETED",
        "customerID": "100000000000137",
        "transactionID": "2590",
        "credit": false
      },
      {
        "type": "DEPOSIT",
        "ReferenceID": "XXXMW20210512000018",
        "timeStamp": "2021-02-16T07:44:55-05:00",
        "instructedAmount": {
          "amount": 10000,
          "currency": "USD"
        },
        "availableBalance": {
          "amount": 10000,
          "currency": "USD"
        },
        "debtorAccount": {
          "reference": "txn000013"
        },
        "creditorAccount": {
          "accountNumber": "200654772393698",
          "customerName": "Sam DIAZ",
          "customerID": "100000000000137"
        },
        "processID": "PL21052500000172",
        "mode": "PG",
        "status": "COMPLETED",
        "customerID": "100000000000137",
        "transactionID": "2589",
        "credit": true
      }
    ]
  }
}

List Transaction by Account

Method: POST​

Headers​

Example​

Body​

Response: 200​

Method: POST

Headers

Example

Body

Response: 200